.. _CLUAConsole Functions:

=========================
C (CLUAConsole) Functions
=========================

.. toctree::
   :maxdepth: 1
   :hidden:
   :glob:

   C_*

.. note:: CLUAConsole functions are accessed via the ``C:`` prefix

+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| **Function**                                       | **Description**                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`C\:AddGold<C_AddGold>`                       | Adds gold to the party                                                                      |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`C\:AddSpell<C_AddSpell>`                     | Adds a spell to the specified character                                                     |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`C\:AdvanceRealTime<C_AdvanceRealTime>`       | Advance time                                                                                |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`C\:CreateCreature<C_CreateCreature>`         | Creates the creature specified                                                              |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`C\:CreateEngine<C_CreateEngine>`             | Unknown                                                                                     |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`C\:CreateItem<C_CreateItem>`                 | Create an item                                                                              |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`C\:CreateVEFVidCell<C_CreateVEFVidCell>`     | Create VEFVidCell                                                                           |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`C\:DisplayAllBAMFiles<C_DisplayAllBAMFiles>` | Display all BAM files                                                                       |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`C\:DisplayText<C_DisplayText>`               | Displays the specified text on screen                                                       |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`C\:EnableCheatKeys<C_EnableCheatKeys>`       | Enable cheat keys                                                                           |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`C\:Eval<C_Eval>`                             | Evaluate a string containing script actions for a character                                 |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`C\:Exec<C_Exec>`                             | Execute console commands contained in the specified file                                    |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`C\:ExploreArea<C_ExploreArea>`               | Reveals the entire map for the current area                                                 |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`C\:GetGlobal<C_GetGlobal>`                   | Gets a global variable value for an area                                                    |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`C\:LogMessages<C_LogMessages>`               | Enables or disables logging output to console                                               |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`C\:LogSet<C_LogSet>`                         | Sets logging to a file instead of to console if logging is enabled                          |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`C\:MoveToArea<C_MoveToArea>`                 | Move the selected characters to the area specified                                          |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`C\:PickDialog<C_PickDialog>`                 | Unknown                                                                                     |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`C\:PlayMovie<C_PlayMovie>`                   | Plays the specified movie                                                                   |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`C\:PlaySound<C_PlaySound>`                   | Plays the specified sound                                                                   |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`C\:ResetAchievements<C_ResetAchievements>`   | Reset achievements - applies to Steam installation only                                     |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`C\:SetCurrentXP<C_SetCurrentXP>`             | Sets the experience points (XP) of the selected character                                   |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`C\:SetGlobal<C_SetGlobal>`                   | Set a global variable to the specified value                                                |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`C\:SetWaterAlpha<C_SetWaterAlpha>`           | Sets the alpha blend level for water transparency                                           |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`C\:SetWeather<C_SetWeather>`                 | Sets the current weather                                                                    |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`C\:StartStore<C_StartStore>`                 | Starts the specified store                                                                  |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`C\:StrrefOff<C_StrrefOff>`                   | Strings are not displayed with their associated string reference (StrRef)                   |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`C\:StrrefOn<C_StrrefOn>`                     | Strings are displayed with their associated string reference (StrRef)                       |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`C\:TestAllDialog<C_TestAllDialog>`           | Lists all dialog file in the game, and checks for errors                                    |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`C\:WorkshopUpload<C_WorkshopUpload>`         | Upload a module to the Steam Workshop - applies to Steam installation only                  |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`C\:WriteScript<C_WriteScript>`               | Output scripts to directory                                                                 |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`C\:new<C_new>`                               | Create a new instance of the CLUAConsole                                                    |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+


::

   C = CLUAConsole:new()